Rename metric variants to follow a consistent naming scheme #367
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames metric variants in the metrics.proto file to follow a consistent core‑concept to modifier naming scheme for improved clarity.
- Renamed AC power metric enums from the old naming convention to the new one in metrics.proto
- Updated the RELEASE_NOTES.md to reflect the naming changes and improve formatting consistency
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/metrics/metrics.proto | Renamed AC power and energy metric enum values to follow the new naming scheme |
| RELEASE_NOTES.md | Updated release notes bullet point formatting and descriptions to reflect the renaming |
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/metrics/metrics.proto:104
- The new enum names follow a consistent scheme, but please verify that all enum names and related comments accurately reflect the core-concept to modifier naming convention.
METRIC_AC_POWER_APPARENT = 22;
RELEASE_NOTES.md:15
- [nitpick] Ensure the bullet list formatting and punctuation are consistent with the rest of the document to maintain clarity in the release notes.
- `microgrid.sensors.SensorCategory`, since it was not useful and potentially confusing.
llucax
reviewed
Jun 13, 2025
Contributor
llucax
left a comment
llucax
left a comment
There was a problem hiding this comment.
Renames look good to me but there are some issues with the release notes.
This commit renames the metric variants in `metrics.proto` to follow a more consistent naming scheme. The new naming convention uses a core-concept to modifier format, which improves clarity and consistency across the metric definitions. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
360_rename_metrics
branch
from
20639aa to
8b66fd1
Compare
llucax
approved these changes
Jun 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit renames the metric variants in
metrics.prototo follow a more consistent naming scheme. The new naming convention uses a core-concept to modifier format, which improves clarity and consistency across the metric definitions.closes #360